﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class SECSMessage
 </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class SECSMessage
 ">
  
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
  
  
  
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../../index.html">
                <img id="logo" class="svg" src="../../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage">


  <h1 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage" class="text-break">Class SECSMessage
</h1>
  <div class="markdown level0 summary"><p>This class represents a SECS message that will be
sent to some other entity or a SECS message that has been
received from some other entity.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">SECSMessage</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.html">com.CIMthetics.CSharpSECSTools.SECSCommUtils</a></h6>
  <h6><strong>Assembly</strong>: SECSCommUtils.dll</h6>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class SECSMessage</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage__ctor_com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSHeader_com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.#ctor(com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader,com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem)">SECSMessage(SECSHeader, SECSItem)</h4>
  <div class="markdown level1 summary"><p>This constructor is typically used in the situation where the
payload of a SECS message was created by
a programmer as a <code>SECSItem</code> and is ready to be sent to some other entity.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSMessage(SECSHeader header, SECSItem body)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader.html">SECSHeader</a></td>
        <td><span class="parametername">header</span></td>
        <td><p>The SECS message header (either a <code>HSMSHeader</code> or a <code>SECSIHeader</code>)
to be used in this message.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="../SECSItems/com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html">SECSItem</a></td>
        <td><span class="parametername">body</span></td>
        <td><p>The body / content / payload of the SECS message to be sent.</p>
</td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage__ctor_com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSHeader_System_Byte___" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.#ctor(com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader,System.Byte[])">SECSMessage(SECSHeader, Byte[])</h4>
  <div class="markdown level1 summary"><p>This constructor is typically used in the situation where a
SECS message was received from either a SECS-I connection or
an HSMS connection.  The body in this situation will be in
the form of a <code>byte[]</code> of bytes received from some other
entity.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSMessage(SECSHeader header, byte[] body)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader.html">SECSHeader</a></td>
        <td><span class="parametername">header</span></td>
        <td><p>The SECS message header (either a <code>HSMSHeader</code> or a <code>SECSIHeader</code>)
to be used in this message.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><span class="parametername">body</span></td>
        <td><p>The body / content / payload of the SECS message to be sent.</p>
</td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage__ctor_com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSHeader_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.#ctor(com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader)">SECSMessage(SECSHeader)</h4>
  <div class="markdown level1 summary"><p>This constructor is typically used in the situation where the
message is to be header only.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSMessage(SECSHeader header)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader.html">SECSHeader</a></td>
        <td><span class="parametername">header</span></td>
        <td><p>The SECS message header (either a <code>HSMSHeader</code> or a <code>SECSIHeader</code>)
to be used in this message.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_Body_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.Body*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_Body" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.Body">Body</h4>
  <div class="markdown level1 summary"><p>The body / payload / contents of this <code>SECSMessage</code>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public byte[] Body { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><p>The message body component of this <code>SECSMessage</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_Body_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Returns an empty <code>byte[]</code> in the event this is a header
only (<code>IsHeaderOnly</code> is <code>true</code>) message.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_Header_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.Header*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_Header" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.Header">Header</h4>
  <div class="markdown level1 summary"><p>The SECS message header (either an <code>HSMSHeader</code> or a <code>SECSIHeader</code>)
of this <code>SECSMessage</code></p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSHeader Header { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader.html">SECSHeader</a></td>
        <td><p>The message header component of this <code>SECSMessage</code>.</p>
</td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_IsHeaderOnly_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.IsHeaderOnly*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_IsHeaderOnly" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.IsHeaderOnly">IsHeaderOnly</h4>
  <div class="markdown level1 summary"><p>True if this <code>SECSMessage</code> is a header only message.  In other
words, it is a message that only contains a message header portion
and does not have a body to go with it.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsHeaderOnly { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p><code>true</code> if this <code>SECSMessage</code> contains a <code>Header</code> without a <code>Body</code> component.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_EncodeForTransport_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.EncodeForTransport*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_EncodeForTransport" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.EncodeForTransport">EncodeForTransport()</h4>
  <div class="markdown level1 summary"><p>This method encodes this <code>SECSMessage</code> into a form where it may
written out as a <code>byte[]</code> to some entity.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public byte[] EncodeForTransport()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><p>A <code>byte[]</code> containing the information ready to be written out
on a connection to some entity.</p>
</td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_GetBodyAsSECSItem_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.GetBodyAsSECSItem*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_GetBodyAsSECSItem" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSMessage.GetBodyAsSECSItem">GetBodyAsSECSItem()</h4>
  <div class="markdown level1 summary"><p>Returns the body / payload / contents of this <code>SECSMessage</code> as a <code>SECSItem</code>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSItem GetBodyAsSECSItem()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="../SECSItems/com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html">SECSItem</a></td>
        <td><p>A <code>SECSItem</code> representation of this <code>SECSMessage</code>'s body / payload.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSMessage_GetBodyAsSECSItem_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>This method returns <code>null</code> in the case where this <code>SECSMessage</code> is a header
only message.</p>
</div>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
